<!-- HTML header for doxygen 1.8.20-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<meta name="generator" content="Doxygen 1.9.4"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>Raspberry Pi Pico SDK: include/hardware/sync/spin_lock.h Source File</title>
	<!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	<link href="normalise.css" rel="stylesheet" type="text/css"/>
<link href="main.css" rel="stylesheet" type="text/css"/>
<link href="styles.css" rel="stylesheet" type="text/css"/>
</head>
<body>
	<div class="navigation-mobile">
		<div class="logo--mobile">
			<a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
		</div>
		<div class="navigation-toggle">
			<span class="line-1"></span>
			<span class="line-2">
				<p>Menu Toggle</p>
			</span>
			<span class="line-3"></span>
		</div>
	</div>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
		<div class="logo">
			<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
			<span style="display: inline-block; margin-top: 10px;">
				v2.0.0
			</span>
		</div>
		<div class="navigation-footer">
			<img src="logo-mobile.svg" alt="Raspberry Pi">
			<a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
		</div>
<!-- 		<div class="search">
			<form>
				<input type="search" name="search" id="search" placeholder="Search">
				<input type="submit" value="Search">
			</form>
		</div> -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('spin__lock_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle"><div class="title">spin_lock.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright (c) 2024 Raspberry Pi (Trading) Ltd.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * SPDX-License-Identifier: BSD-3-Clause</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> */</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#ifndef _HARDWARE_SYNC_SPIN_LOCK_H</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _HARDWARE_SYNC_SPIN_LOCK_H</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#include &quot;<a class="code" href="pico_8h.html">pico.h</a>&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#include &quot;<a class="code" href="rp2__common_2hardware__sync_2include_2hardware_2sync_8h.html">hardware/sync.h</a>&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment">// PICO_CONFIG: PICO_USE_SW_SPIN_LOCKS, Use software implementation for spin locks, type=bool, default=1 on RP2350 due to errata, group=hardware_sync</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">#ifndef PICO_USE_SW_SPIN_LOCKS</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="preprocessor">#if PICO_RP2350</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="preprocessor">#define PICO_USE_SW_SPIN_LOCKS 1</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment">// PICO_CONFIG: PICO_SPINLOCK_ID_IRQ, Spinlock ID for IRQ protection, min=0, max=31, default=9, group=hardware_sync</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#ifndef PICO_SPINLOCK_ID_IRQ</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#define PICO_SPINLOCK_ID_IRQ 9</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment">// PICO_CONFIG: PICO_SPINLOCK_ID_TIMER, Spinlock ID for Timer protection, min=0, max=31, default=10, group=hardware_sync</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#ifndef PICO_SPINLOCK_ID_TIMER</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#define PICO_SPINLOCK_ID_TIMER 10</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment">// PICO_CONFIG: PICO_SPINLOCK_ID_HARDWARE_CLAIM, Spinlock ID for Hardware claim protection, min=0, max=31, default=11, group=hardware_sync</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="preprocessor">#ifndef PICO_SPINLOCK_ID_HARDWARE_CLAIM</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="preprocessor">#define PICO_SPINLOCK_ID_HARDWARE_CLAIM 11</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment">// PICO_CONFIG: PICO_SPINLOCK_ID_RAND, Spinlock ID for Random Number Generator, min=0, max=31, default=12, group=hardware_sync</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="preprocessor">#ifndef PICO_SPINLOCK_ID_RAND</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="preprocessor">#define PICO_SPINLOCK_ID_RAND 12</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment">// PICO_CONFIG: PICO_SPINLOCK_ID_ATOMIC, Spinlock ID for atomics, min=0, max=31, default=13, group=hardware_sync</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="preprocessor">#ifndef PICO_SPINLOCK_ID_ATOMIC</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="preprocessor">#define PICO_SPINLOCK_ID_ATOMIC 13</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment">// PICO_CONFIG: PICO_SPINLOCK_ID_OS1, First Spinlock ID reserved for use by low level OS style software, min=0, max=31, default=14, group=hardware_sync</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="preprocessor">#ifndef PICO_SPINLOCK_ID_OS1</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="preprocessor">#define PICO_SPINLOCK_ID_OS1 14</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment">// PICO_CONFIG: PICO_SPINLOCK_ID_OS2, Second Spinlock ID reserved for use by low level OS style software, min=0, max=31, default=15, group=hardware_sync</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="preprocessor">#ifndef PICO_SPINLOCK_ID_OS2</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="preprocessor">#define PICO_SPINLOCK_ID_OS2 15</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment">// PICO_CONFIG: PICO_SPINLOCK_ID_STRIPED_FIRST, Lowest Spinlock ID in the &#39;striped&#39; range, min=0, max=31, default=16, group=hardware_sync</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="preprocessor">#ifndef PICO_SPINLOCK_ID_STRIPED_FIRST</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="preprocessor">#define PICO_SPINLOCK_ID_STRIPED_FIRST 16</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment">// PICO_CONFIG: PICO_SPINLOCK_ID_STRIPED_LAST, Highest Spinlock ID in the &#39;striped&#39; range, min=0, max=31, default=23, group=hardware_sync</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="preprocessor">#ifndef PICO_SPINLOCK_ID_STRIPED_LAST</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="preprocessor">#define PICO_SPINLOCK_ID_STRIPED_LAST 23</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment">// PICO_CONFIG: PICO_SPINLOCK_ID_CLAIM_FREE_FIRST, Lowest Spinlock ID in the &#39;claim free&#39; range, min=0, max=31, default=24, group=hardware_sync</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="preprocessor">#ifndef PICO_SPINLOCK_ID_CLAIM_FREE_FIRST</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="preprocessor">#define PICO_SPINLOCK_ID_CLAIM_FREE_FIRST 24</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="preprocessor">#ifdef PICO_SPINLOCK_ID_CLAIM_FREE_END</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="preprocessor">#warning PICO_SPINLOCK_ID_CLAIM_FREE_END has been renamed to PICO_SPINLOCK_ID_CLAIM_FREE_LAST</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">// PICO_CONFIG: PICO_SPINLOCK_ID_CLAIM_FREE_LAST, Highest Spinlock ID in the &#39;claim free&#39; range, min=0, max=31, default=31, group=hardware_sync</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="preprocessor">#ifndef PICO_SPINLOCK_ID_CLAIM_FREE_LAST</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="preprocessor">#define PICO_SPINLOCK_ID_CLAIM_FREE_LAST 31</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="preprocessor">#if !PICO_USE_SW_SPIN_LOCKS</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">// Hardware lock flag in SIO:</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="keyword">typedef</span> io_rw_32 spin_lock_t;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="preprocessor">#ifndef SW_SPIN_LOCK_TYPE</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">// Byte flag in memory:</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="group__hardware__sync.html#gae73045822d06a1733a5bbfbda7895998">   88</a></span><span class="preprocessor">#define SW_SPIN_LOCK_TYPE volatile uint8_t</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="keyword">typedef</span> <a class="code hl_define" href="group__hardware__sync.html#gae73045822d06a1733a5bbfbda7895998">SW_SPIN_LOCK_TYPE</a> spin_lock_t;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="preprocessor">#if PICO_USE_SW_SPIN_LOCKS</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="preprocessor">#ifndef SW_SPIN_LOCK_INSTANCE</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="preprocessor">#define SW_SPIN_LOCK_INSTANCE(lock_num) ({             \</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="preprocessor">    extern spin_lock_t _sw_spin_locks[NUM_SPIN_LOCKS]; \</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="preprocessor">    &amp;_sw_spin_locks[lock_num];                         \</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="preprocessor">    })</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="preprocessor">#ifndef SW_SPIN_LOCK_NUM</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="preprocessor">#define SW_SPIN_LOCK_NUM(lock) ({                          \</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="preprocessor">        extern spin_lock_t _sw_spin_locks[NUM_SPIN_LOCKS]; \</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="preprocessor">        (lock) - _sw_spin_locks;                           \</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="preprocessor">        })</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span> </div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="preprocessor">#ifndef SW_SPIN_LOCK_IS_LOCKED</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="preprocessor">#define SW_SPIN_LOCK_IS_LOCKED(lock) ((bool) *(lock))</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="preprocessor">#ifndef SW_SPIN_LOCK_LOCK</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="preprocessor">#if __ARM_ARCH_8M_MAIN__</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="preprocessor">#define SW_SPIN_LOCK_LOCK(lock) ({                             \</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="preprocessor">    uint32_t _tmp0, _tmp1;                                     \</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="preprocessor">    pico_default_asm_volatile (                                \</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="preprocessor">    &quot;1:\n&quot;</span>                                                     \</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span>    &quot;ldaexb %1, [%2]\n&quot;                                        \</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span>    &quot;movs %0, #1\n&quot; <span class="comment">/* fill dependency slot */</span><span class="preprocessor">                 \</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="preprocessor">    &quot;cmp %1, #0\n&quot;</span>                                             \</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span>    <span class="comment">/* Immediately retry if lock is seen to be taken */</span><span class="preprocessor">        \</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="preprocessor">    &quot;bne 1b\n&quot;</span>                                                 \</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span>    <span class="comment">/* Attempt to claim */</span><span class="preprocessor">                                     \</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="preprocessor">    &quot;strexb %1, %0, [%2]\n&quot;</span>                                    \</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span>    &quot;cmp %1, #0\n&quot;                                             \</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span>    <span class="comment">/* Claim failed due to intervening write, so retry */</span><span class="preprocessor">      \</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="preprocessor">    &quot;bne 1b\n&quot;</span>                                                 \</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span>    : &quot;=&amp;r&quot; (_tmp0), &quot;=&amp;r&quot; (_tmp1) : &quot;r&quot; (lock)                \</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span>    );                                                         \</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>    __mem_fence_acquire();                                     \</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span>    })</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="preprocessor">#elif __riscv &amp;&amp; (defined(__riscv_a) || defined(__riscv_zaamo))</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="preprocessor">#define SW_SPIN_LOCK_LOCK(lock) ({                                              \</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="preprocessor">    uint32_t _tmp0, _tmp1;                                                      \</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="preprocessor">    pico_default_asm_volatile (                                                 \</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="preprocessor">        </span><span class="comment">/* Get word address, and bit mask for LSB of the */</span><span class="preprocessor">                     \</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="preprocessor">        </span><span class="comment">/* correct byte within that word -- note shamt is modulo xlen: */</span><span class="preprocessor">       \</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="preprocessor">        &quot;slli %1, %0, 3\n&quot;</span>                                                      \</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>        &quot;bset %1, zero, %1\n&quot;                                                   \</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>        &quot;andi %0, %0, -4\n&quot;                                                     \</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>        <span class="comment">/* Repeatedly set the bit until we see that it was clear at the */</span><span class="preprocessor">      \</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="preprocessor">        </span><span class="comment">/* point we set it. A set from 0 -&gt; 1 is a successful lock take. */</span><span class="preprocessor">     \</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="preprocessor">    &quot;1:&quot;</span>                                                                        \</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span>        &quot;amoor.w.aq %2, %1, (%0)\n&quot;                                             \</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span>        &quot;and %2, %2, %1\n&quot;                                                      \</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span>        &quot;bnez %2, 1b\n&quot;                                                         \</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span>        : &quot;+r&quot; (lock), &quot;=r&quot; (_tmp0), &quot;=r&quot; (_tmp1)                               \</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span>    );                                                                          \</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>    __mem_fence_acquire();                                                      \</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span>    })</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="preprocessor">#error no SW_SPIN_TRY_LOCK available for PICO_USE_SW_SPIN_LOCK on this platform</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span> </div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="preprocessor">#ifndef SW_SPIN_TRY_LOCK</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="preprocessor">#if __ARM_ARCH_8M_MAIN__</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="preprocessor">#define SW_SPIN_TRY_LOCK(lock) ({                              \</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="preprocessor">    uint32_t _tmp0, _tmp1;                                     \</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="preprocessor">    pico_default_asm_volatile (                                \</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="preprocessor">    &quot;ldaexb %1, [%2]\n&quot;</span>                                        \</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span>    &quot;movs %0, #1\n&quot; <span class="comment">/* fill dependency slot */</span><span class="preprocessor">                 \</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="preprocessor">    &quot;cmp %1, #0\n&quot;</span>                                             \</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>    <span class="comment">/* Immediately give up if lock is seen to be taken */</span><span class="preprocessor">      \</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="preprocessor">    &quot;bne 1f\n&quot;</span>                                                 \</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span>    <span class="comment">/* Otherwise attempt to claim, once. */</span><span class="preprocessor">                    \</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="preprocessor">    &quot;strexb %1, %0, [%2]\n&quot;</span>                                    \</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span>    &quot;1:\n&quot;                                                     \</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span>    : &quot;=&amp;r&quot; (_tmp0), &quot;=&amp;r&quot; (_tmp1) : &quot;r&quot; (lock)                \</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span>    );                                                         \</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span>    __mem_fence_acquire();                                     \</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span>    !_tmp1;                                                    \</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span>    })</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="preprocessor">#elif __riscv &amp;&amp; (defined(__riscv_a) || defined(__riscv_zaamo))</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="preprocessor">#define SW_SPIN_TRY_LOCK(lock) ({                                               \</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="preprocessor">    uint32_t _tmp0;                                                             \</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="preprocessor">    pico_default_asm_volatile (                                                 \</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="preprocessor">        </span><span class="comment">/* Get word address, and bit mask for LSB of the */</span><span class="preprocessor">                     \</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="preprocessor">        </span><span class="comment">/* correct byte within that word -- note shamt is modulo xlen: */</span><span class="preprocessor">       \</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="preprocessor">        &quot;slli %1, %0, 3\n&quot;</span>                                                      \</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span>        &quot;bset %1, zero, %1\n&quot;                                                   \</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span>        &quot;andi %0, %0, -4\n&quot;                                                     \</div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span>        <span class="comment">/* Set the bit. If it was clear at the point we set it, then we took */</span><span class="preprocessor"> \</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="preprocessor">        </span><span class="comment">/* the lock. Otherwise the lock was already held, and we give up. */</span><span class="preprocessor">    \</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="preprocessor">        &quot;amoor.w.aq %0, %1, (%0)\n&quot;</span>                                             \</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span>        &quot;and %1, %1, %0\n&quot;                                                      \</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span>        : &quot;+r&quot; (lock), &quot;=r&quot; (_tmp0)                                             \</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span>    );                                                                          \</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span>    __mem_fence_acquire();                                                      \</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span>    !_tmp0;                                                                     \</div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span>    })</div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="preprocessor">#error no SW_SPIN_TRY_LOCK available for PICO_USE_SW_SPIN_LOCK on this platform</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span> </div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="preprocessor">#ifndef SW_SPIN_LOCK_UNLOCK</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="preprocessor">#if __ARM_ARCH_8M_MAIN__</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="preprocessor">#define SW_SPIN_LOCK_UNLOCK(lock) ({                                        \</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="preprocessor">    </span><span class="comment">/* Release-ordered store is available: use instead of separate fence */</span><span class="preprocessor"> \</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="preprocessor">    uint32_t zero = 0;                                                      \</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="preprocessor">    pico_default_asm_volatile(                                              \</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="preprocessor">        &quot;stlb %0, [%1]\n&quot;</span>                                                   \</div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span>        : : &quot;r&quot; (zero), &quot;r&quot; (lock)                                          \</div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span>    );                                                                      \</div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span>    })</div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="preprocessor">#elif __riscv</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="preprocessor">#define SW_SPIN_LOCK_UNLOCK(lock) ({                              \</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="preprocessor">    __mem_fence_release();                                        \</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="preprocessor">    *(lock) = 0; </span><span class="comment">/* write to spinlock register (release lock) */</span><span class="preprocessor">  \</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="preprocessor">    })</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="preprocessor">#error no SW_SPIN_TRY_LOCK available for PICO_USE_SW_SPIN_LOCK on this platform</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span> </div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span> </div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"><a class="line" href="group__hardware__sync.html#ga87b2474d96a8de8cdc6e083680a05bb9">  225</a></span><a class="code hl_define" href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a> <span class="keyword">static</span> spin_lock_t *<a class="code hl_function" href="group__hardware__sync.html#ga87b2474d96a8de8cdc6e083680a05bb9">spin_lock_instance</a>(uint lock_num) {</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span>    invalid_params_if(HARDWARE_SYNC, lock_num &gt;= NUM_SPIN_LOCKS);</div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="preprocessor">#if PICO_USE_SW_SPIN_LOCKS</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span>    <span class="keywordflow">return</span> SW_SPIN_LOCK_INSTANCE(lock_num);</div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span>    <span class="keywordflow">return</span> (spin_lock_t *) (SIO_BASE + SIO_SPINLOCK0_OFFSET + lock_num * 4);</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span>}</div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span> </div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"><a class="line" href="group__hardware__sync.html#gad86f015d3ed475401bf83d9a0e449ab1">  240</a></span><a class="code hl_define" href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a> <span class="keyword">static</span> uint <a class="code hl_function" href="group__hardware__sync.html#gad86f015d3ed475401bf83d9a0e449ab1">spin_lock_get_num</a>(spin_lock_t *lock) {</div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="preprocessor">#if PICO_USE_SW_SPIN_LOCKS</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span>    uint lock_num = SW_SPIN_LOCK_NUM(lock);</div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span>    invalid_params_if(HARDWARE_SYNC, lock_num &gt;= (uint)NUM_SPIN_LOCKS);</div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span>    <span class="keywordflow">return</span> lock_num;</div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span>    invalid_params_if(HARDWARE_SYNC, (uint) lock &lt; SIO_BASE + SIO_SPINLOCK0_OFFSET ||</div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span>                            (uint) lock &gt;= NUM_SPIN_LOCKS * <span class="keyword">sizeof</span>(spin_lock_t) + SIO_BASE + SIO_SPINLOCK0_OFFSET ||</div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span>                            ((uint) lock - SIO_BASE + SIO_SPINLOCK0_OFFSET) % <span class="keyword">sizeof</span>(spin_lock_t) != 0);</div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span>    <span class="keywordflow">return</span> (uint) (lock - (spin_lock_t *) (SIO_BASE + SIO_SPINLOCK0_OFFSET));</div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span>}</div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span> </div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno"><a class="line" href="group__hardware__sync.html#gac4c9286f66d9dbe5287904d481f3b1e3">  258</a></span><a class="code hl_define" href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__hardware__sync.html#gac4c9286f66d9dbe5287904d481f3b1e3">spin_lock_unsafe_blocking</a>(spin_lock_t *lock) {</div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span>    <span class="comment">// Note we don&#39;t do a wfe or anything, because by convention these spin_locks are VERY SHORT LIVED and NEVER BLOCK and run</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span>    <span class="comment">// with INTERRUPTS disabled (to ensure that)... therefore nothing on our core could be blocking us, so we just need to wait on another core</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span>    <span class="comment">// anyway which should be finished soon</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="preprocessor">#if PICO_USE_SW_SPIN_LOCKS</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span>    SW_SPIN_LOCK_LOCK(lock);</div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span>    <span class="keywordflow">while</span> (__builtin_expect(!*lock, 0)) { <span class="comment">// read from spinlock register (tries to acquire the lock)</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span>        <a class="code hl_function" href="group__pico__platform.html#gab0d1ba75ceb64131e19f613d7a5313c9">tight_loop_contents</a>();</div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span>    }</div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span>    <a class="code hl_function" href="group__hardware__sync.html#gaac3457fdba1624e5f45e7f936ad68049">__mem_fence_acquire</a>();</div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span>}</div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span> </div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span><a class="code hl_define" href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> spin_try_lock_unsafe(spin_lock_t *lock) {</div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span><span class="preprocessor">#if PICO_USE_SW_SPIN_LOCKS</span></div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span>    <span class="keywordflow">return</span> SW_SPIN_TRY_LOCK(lock);</div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span>    <span class="keywordflow">return</span> *lock;</div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span>}</div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno"><a class="line" href="group__hardware__sync.html#ga1cc04df1f5717292b279eb197ff5b4af">  284</a></span><a class="code hl_define" href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__hardware__sync.html#ga1cc04df1f5717292b279eb197ff5b4af">spin_unlock_unsafe</a>(spin_lock_t *lock) {</div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="preprocessor">#if PICO_USE_SW_SPIN_LOCKS</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span>    SW_SPIN_LOCK_UNLOCK(lock);</div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span>    <a class="code hl_function" href="group__hardware__sync.html#ga1a9f3cba87fe49a3907a1535b9adfa3f">__mem_fence_release</a>();</div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span>    *lock = 0; <span class="comment">// write to spinlock register (release lock)</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span>}</div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span> </div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno"><a class="line" href="group__hardware__sync.html#ga091e88a7608ed8dbf3e1e984bae54602">  301</a></span><a class="code hl_define" href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a> <span class="keyword">static</span> uint32_t <a class="code hl_function" href="group__hardware__sync.html#ga091e88a7608ed8dbf3e1e984bae54602">spin_lock_blocking</a>(spin_lock_t *lock) {</div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span>    uint32_t save = <a class="code hl_function" href="group__hardware__sync.html#ga15ada9cfb92615e5bb05a29aa3fc7ad8">save_and_disable_interrupts</a>();</div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span>    <a class="code hl_function" href="group__hardware__sync.html#gac4c9286f66d9dbe5287904d481f3b1e3">spin_lock_unsafe_blocking</a>(lock);</div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span>    <span class="keywordflow">return</span> save;</div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span>}</div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span> </div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno"><a class="line" href="group__hardware__sync.html#gada2be3ad9fabcda77e8bec99e12333fd">  312</a></span><span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="group__hardware__sync.html#gada2be3ad9fabcda77e8bec99e12333fd">is_spin_locked</a>(spin_lock_t *lock) {</div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="preprocessor">#if PICO_USE_SW_SPIN_LOCKS</span></div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span>    <span class="keywordflow">return</span> SW_SPIN_LOCK_IS_LOCKED(lock);</div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span>    check_hw_size(spin_lock_t, 4);</div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span>    uint lock_num = <a class="code hl_function" href="group__hardware__sync.html#gad86f015d3ed475401bf83d9a0e449ab1">spin_lock_get_num</a>(lock);</div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span>    <span class="keywordflow">return</span> 0 != (*(io_ro_32 *) (SIO_BASE + SIO_SPINLOCK_ST_OFFSET) &amp; (1u &lt;&lt; lock_num));</div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span>}</div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span> </div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno"><a class="line" href="group__hardware__sync.html#ga281ce69786da23cab7ba6c42537d4e87">  332</a></span><a class="code hl_define" href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__hardware__sync.html#ga281ce69786da23cab7ba6c42537d4e87">spin_unlock</a>(spin_lock_t *lock, uint32_t saved_irq) {</div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span>    <a class="code hl_function" href="group__hardware__sync.html#ga1cc04df1f5717292b279eb197ff5b4af">spin_unlock_unsafe</a>(lock);</div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span>    <a class="code hl_function" href="group__hardware__sync.html#ga4bb69d1717ab90105ea05b82291fc0c7">restore_interrupts_from_disabled</a>(saved_irq);</div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span>}</div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span> </div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span>spin_lock_t *<a class="code hl_function" href="group__hardware__sync.html#gad38821cab3d935b009c6551d5ff70c4c">spin_lock_init</a>(uint lock_num);</div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span> </div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__hardware__sync.html#ga667a78000c57bdfb3585cbc56fccbe0b">spin_locks_reset</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span> </div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="agroup__hardware__sync_html_ga091e88a7608ed8dbf3e1e984bae54602"><div class="ttname"><a href="group__hardware__sync.html#ga091e88a7608ed8dbf3e1e984bae54602">spin_lock_blocking</a></div><div class="ttdeci">static __force_inline uint32_t spin_lock_blocking(spin_lock_t *lock)</div><div class="ttdoc">Acquire a spin lock safely.</div><div class="ttdef"><b>Definition:</b> spin_lock.h:301</div></div>
<div class="ttc" id="agroup__hardware__sync_html_ga15ada9cfb92615e5bb05a29aa3fc7ad8"><div class="ttname"><a href="group__hardware__sync.html#ga15ada9cfb92615e5bb05a29aa3fc7ad8">save_and_disable_interrupts</a></div><div class="ttdeci">static __force_inline uint32_t save_and_disable_interrupts(void)</div><div class="ttdoc">Save and disable interrupts.</div><div class="ttdef"><b>Definition:</b> sync.h:206</div></div>
<div class="ttc" id="agroup__hardware__sync_html_ga1a9f3cba87fe49a3907a1535b9adfa3f"><div class="ttname"><a href="group__hardware__sync.html#ga1a9f3cba87fe49a3907a1535b9adfa3f">__mem_fence_release</a></div><div class="ttdeci">static __force_inline void __mem_fence_release(void)</div><div class="ttdoc">Release a memory fence.</div><div class="ttdef"><b>Definition:</b> sync.h:189</div></div>
<div class="ttc" id="agroup__hardware__sync_html_ga1cc04df1f5717292b279eb197ff5b4af"><div class="ttname"><a href="group__hardware__sync.html#ga1cc04df1f5717292b279eb197ff5b4af">spin_unlock_unsafe</a></div><div class="ttdeci">static __force_inline void spin_unlock_unsafe(spin_lock_t *lock)</div><div class="ttdoc">Release a spin lock without re-enabling interrupts.</div><div class="ttdef"><b>Definition:</b> spin_lock.h:284</div></div>
<div class="ttc" id="agroup__hardware__sync_html_ga281ce69786da23cab7ba6c42537d4e87"><div class="ttname"><a href="group__hardware__sync.html#ga281ce69786da23cab7ba6c42537d4e87">spin_unlock</a></div><div class="ttdeci">static __force_inline void spin_unlock(spin_lock_t *lock, uint32_t saved_irq)</div><div class="ttdoc">Release a spin lock safely.</div><div class="ttdef"><b>Definition:</b> spin_lock.h:332</div></div>
<div class="ttc" id="agroup__hardware__sync_html_ga4bb69d1717ab90105ea05b82291fc0c7"><div class="ttname"><a href="group__hardware__sync.html#ga4bb69d1717ab90105ea05b82291fc0c7">restore_interrupts_from_disabled</a></div><div class="ttdeci">static __force_inline void restore_interrupts_from_disabled(uint32_t status)</div><div class="ttdoc">Restore interrupts to a specified state with restricted transitions.</div><div class="ttdef"><b>Definition:</b> sync.h:249</div></div>
<div class="ttc" id="agroup__hardware__sync_html_ga667a78000c57bdfb3585cbc56fccbe0b"><div class="ttname"><a href="group__hardware__sync.html#ga667a78000c57bdfb3585cbc56fccbe0b">spin_locks_reset</a></div><div class="ttdeci">void spin_locks_reset(void)</div><div class="ttdoc">Release all spin locks.</div><div class="ttdef"><b>Definition:</b> sync_spin_lock.c:8</div></div>
<div class="ttc" id="agroup__hardware__sync_html_ga87b2474d96a8de8cdc6e083680a05bb9"><div class="ttname"><a href="group__hardware__sync.html#ga87b2474d96a8de8cdc6e083680a05bb9">spin_lock_instance</a></div><div class="ttdeci">static __force_inline spin_lock_t * spin_lock_instance(uint lock_num)</div><div class="ttdoc">Get HW Spinlock instance from number.</div><div class="ttdef"><b>Definition:</b> spin_lock.h:225</div></div>
<div class="ttc" id="agroup__hardware__sync_html_gaac3457fdba1624e5f45e7f936ad68049"><div class="ttname"><a href="group__hardware__sync.html#gaac3457fdba1624e5f45e7f936ad68049">__mem_fence_acquire</a></div><div class="ttdeci">static __force_inline void __mem_fence_acquire(void)</div><div class="ttdoc">Acquire a memory fence.</div><div class="ttdef"><b>Definition:</b> sync.h:173</div></div>
<div class="ttc" id="agroup__hardware__sync_html_gac4c9286f66d9dbe5287904d481f3b1e3"><div class="ttname"><a href="group__hardware__sync.html#gac4c9286f66d9dbe5287904d481f3b1e3">spin_lock_unsafe_blocking</a></div><div class="ttdeci">static __force_inline void spin_lock_unsafe_blocking(spin_lock_t *lock)</div><div class="ttdoc">Acquire a spin lock without disabling interrupts (hence unsafe)</div><div class="ttdef"><b>Definition:</b> spin_lock.h:258</div></div>
<div class="ttc" id="agroup__hardware__sync_html_gad38821cab3d935b009c6551d5ff70c4c"><div class="ttname"><a href="group__hardware__sync.html#gad38821cab3d935b009c6551d5ff70c4c">spin_lock_init</a></div><div class="ttdeci">spin_lock_t * spin_lock_init(uint lock_num)</div><div class="ttdoc">Initialise a spin lock.</div><div class="ttdef"><b>Definition:</b> sync_spin_lock.c:14</div></div>
<div class="ttc" id="agroup__hardware__sync_html_gad86f015d3ed475401bf83d9a0e449ab1"><div class="ttname"><a href="group__hardware__sync.html#gad86f015d3ed475401bf83d9a0e449ab1">spin_lock_get_num</a></div><div class="ttdeci">static __force_inline uint spin_lock_get_num(spin_lock_t *lock)</div><div class="ttdoc">Get HW Spinlock number from instance.</div><div class="ttdef"><b>Definition:</b> spin_lock.h:240</div></div>
<div class="ttc" id="agroup__hardware__sync_html_gada2be3ad9fabcda77e8bec99e12333fd"><div class="ttname"><a href="group__hardware__sync.html#gada2be3ad9fabcda77e8bec99e12333fd">is_spin_locked</a></div><div class="ttdeci">static bool is_spin_locked(spin_lock_t *lock)</div><div class="ttdoc">Check to see if a spinlock is currently acquired elsewhere.</div><div class="ttdef"><b>Definition:</b> spin_lock.h:312</div></div>
<div class="ttc" id="agroup__hardware__sync_html_gae73045822d06a1733a5bbfbda7895998"><div class="ttname"><a href="group__hardware__sync.html#gae73045822d06a1733a5bbfbda7895998">SW_SPIN_LOCK_TYPE</a></div><div class="ttdeci">#define SW_SPIN_LOCK_TYPE</div><div class="ttdoc">A spin lock identifier.</div><div class="ttdef"><b>Definition:</b> spin_lock.h:88</div></div>
<div class="ttc" id="agroup__pico__platform_html_ga23eadd8d1642fb8fe4600708c36e116a"><div class="ttname"><a href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a></div><div class="ttdeci">#define __force_inline</div><div class="ttdoc">Attribute to force inlining of a function regardless of optimization level.</div><div class="ttdef"><b>Definition:</b> compiler.h:125</div></div>
<div class="ttc" id="agroup__pico__platform_html_gab0d1ba75ceb64131e19f613d7a5313c9"><div class="ttname"><a href="group__pico__platform.html#gab0d1ba75ceb64131e19f613d7a5313c9">tight_loop_contents</a></div><div class="ttdeci">static __force_inline void tight_loop_contents(void)</div><div class="ttdoc">No-op function for the body of tight loops.</div><div class="ttdef"><b>Definition:</b> platform.h:67</div></div>
<div class="ttc" id="apico_8h_html"><div class="ttname"><a href="pico_8h.html">pico.h</a></div></div>
<div class="ttc" id="arp2__common_2hardware__sync_2include_2hardware_2sync_8h_html"><div class="ttname"><a href="rp2__common_2hardware__sync_2include_2hardware_2sync_8h.html">sync.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->

	<script src="main.js"></script>
</body>
</html>